home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1995 October
/
EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso
/
Aminet
/
comm
/
mebbs
/
extract.lzh
/
extractit.doc
< prev
next >
Wrap
Text File
|
1993-12-07
|
26KB
|
537 lines
SetUp & Operation of: 'ExtractIt/DocReader' - A MEBBSNet BBS Door
(v3.00) 9/25/93
(c) 1991,1992,1993 a.j. saveriano - alchemiga BBS 1:2606/205.0 1-201-398-6360
- 1 - INTRO (original history)
-----
A nitwit friend of mine (Richard Koenig 2606/404) recently came up with
a non-nitwit idea: What about a door that allowed the caller to
READ any text file (doc files, read.me files, etc.) that were compressed
inside of an archived program. The reason behind this request is that,
according to him, users would like the ability to review a doc file
BEFORE they actually download the software.
Hmmm...not a bad concept. Thus was born: DocReader. This door runs
like any other StarNet (now MEBBSNet) door. I have it set up on my system
as a door running from the FileMenu.txt/gr1 menu. (You'll find this file
in your designated MEBBSNet TEXT directory). This seems the most logical place
to have this set up since the caller will most probably already be in
this menu when scanning and looking at your file transfers.
DocReader not only allows you to read text files that are inbedded
inside a compressed file but it allows you to view a compressed directory
and also lets you read ANY uncompressed text files that may also be
online. The file of interest can be imbedded inside of an ARC, LHZ, LHA,
ZOO or ZIP file.
But alas, tis not enough. A new request comes from the nitwit as well
as other MEBBSNet Sysops. How 'bout a door that allows selective
decompressing of any or all files inside of an archive? And then, how
about having these selected files re-compressed and made available for
downloading to the user? Hmmmm......why would you need such a door, I asked?
Well, suppose you inadvertently deleted one or two files of a multi-file
piece of software? Or what if you lost the doc file for something? You'd
have to re-download the entire file in order to replace these files.
Therefore, with a door like this one, you could download just the piece
that you needed. Ok...I see the point. Thus was born: ExtractIt.
The final file is attached to an E-mail message utilizing MEBBSNet's
builtin Robot Message feature.
This door: ExtractIt/DocReader, is a combination of the two doors
described above. Anyone already using the original DocReader can now dump
it and replace it with this new combo door. An option is provided to allow
you to toggle on/off either or both of these door functions.
- 2 - SETUP
-----
IMPORTANT: The E-mail section of MEBBSNet MUST be PRIVATE as
defined in MEBBSNet config. However, it can be ANY message area
number (You're welcome Bill Carney :). If this is not the case, you will
need to re-config your system so that E-mail is a PRIVATE area. (I can't
imagine that this is not the case).
This door requires a stack of at least 25000. This should present no
problems since you are probably running MEBBSNet itself at a stack of
over 25000. If you don't run the BBS at 25000 or more, you will have to
raise the stack in order for this door to operate.
The following AmigaDOS assignments MUST be made for this door to operate.
You most likely have these assignments already made:
1) assign MEBBSNet: --> to your main MEBBSNet directory
2) assign doors: --> to your MEBBSNet doors directory
You must already have assignment number 1 done otherwise you would be
having problems with MEBBSNet in general! :). Next create a directory called
EXTRACT in your assigned doors: directory. Inside this new directory, copy
the following files:
1) ExtractIt
2) TESTMESSAGE
3) DocRead.cfg (See section -4- below for full details)
Be certain the mebbsutility.library you received with MEBBSNet
is in your libs: directory. This door will NOT function if you
forget this step.
******************
IMPORTANT!!
******************
You MUST also have the following files already in either your C directory or
in a directory that is scanned by your present PATH setup:
(Check with your local Amiga Guru if the above sentence causes
you any confusion.)
PKAX (v1.0)
ZOO (v2.01 or higher) NOT ZOO 2.00 !!
LZ (v1.92 by J. Forbes)
ARCV (v1.06)
UNZIP (I am using v3.10 by S.H. Smith)
ARC (v0.23 - AmigaArc CopyRight 1986,87 - R.S. Brand)
Again, please note: This file must be in your libs: directory -
mebbsutility.library (v1.8 or higher)
They MUST be named just as you see them listed above. NO OTHER VERSIONS ARE
TO BE USED! I don't know if older/other versions will work properly.
The standard Amiga CD, DELETE and COPY commands must also be in your
C directory. (I'm sure they are already in there!). Please note, however,
if you are using WB2.0 or higher, the CD command is internal and, therefore,
you do not need to have the CD command inside any directory.
- 3 - MENU MODIFICATIONS:
-------------------
Here is an excerpt from my un-compiled file transfer menu that shows
the addition of this door:
;
; This is a file area menu.
;
Page 2
Type File
Helpfile Default FileMenu
Option 'W':
Function Rundoor DOORS:Extract/ExtractIt
minaccess 4
end
;
;
Compile the modified menu and copy it over to your designated MENU
directory and then re-boot MEBBSNet. Check the MEBBSNet documentation
if you have never modified a menu.
The following is what my FileMenu.txt looks like:
--------
Control Parameters for File Transfers
And File Searches
-----------------------------------------
[W] ExtractIt/DocReader - Selective File Extractor/Documentation Reader
[B] Batch download marked files [C] Chat with SysOp
[R] Remove marked files [F] Find files (Global scan/list
[G] Goodbye - Logoff [I] Info on marked files
[L] Verbose list of files [M] Mark a file
[O] Move to Other file areas [Q] Quit to main menu
[U] Upload a File [S] Short scan of files
[T] Toggle libraries for Find util. [V] View an ARC, LZH or ZOO file
Time Remaining: ~vh minutes
----------
As you can see, I have the door run by typing letter W. You, of course,
can give it any letter you like.
- 4 - EDITING the DocRead.cfg file
--------------------------------
In order for this door to operate properly, it must know WHERE to look
for the file that is chosen by the user. As set up via the MEBBSNet config
file, you have set up the DEVICES used and the LIBRARY DIRECTORY used for
each file area you have on your system. (If you've forgotten this, run
MEBBSCfg and click on EDIT FILE AREA. Look at all the areas in the selector
window).
DocRead.cfg is simply a listing of ALL the places that your downloads can
be stored. As an example, let us say that you have designated 3 partitions
and 5 different directories to store ALL the files you have available for
downloading. Lets also say that the partitions are called SH0:, DH0: and DH1:
The following is what the DocRead.cfg file might look like:
0
0
15
1
bbs:messages/1/
ram:
1
SH0:Transfers/downloads/
SH0:MoreDownloads/
DH0:Transfers/downloads/
DH0:Downloads/
DH1:Transfers/
SH0:EvenMoreTransfers/
LINES 1 and 2 of the docread.cfg file
-------------------------------------
The first TWO lines in the .cfg file are reserved for the toggling
of the door functions. If line 1 has a 0 (zero) then the ExtractIt
portion of this door is active. If that line has a 1 (one) then ExtractIt
is not available to the users. Line TWO of the .cfg file is used in the
exact same way as line one, but it applies to the DocReader section of
the door.
LINE 3 of the docread.cfg file
------------------------------
The third line is used to tell the door how many files you wish to
allow your users to selectively extract. In other words, if you put a
number 10 there, then your users will be allowed to selectively extract
10 files before the doors packs up his choices. A number 150 will allow
your users 150 choices (wow! :).
LINE 4 of the docread.cfg file
------------------------------
The fourth line is used to tell the door what message area number
is set up as private Email. Therefore, a number 1 in this spot, would
tell the door that message area one is Email. A 128 in this spot would
tell it that message area 128 is Email.
LINE 5 of the docread.cfg file
------------------------------
The fifth line tells the door the exact path of your private Email
message base. This line is a more detailed version of line 4 and must
be included otherwise the file-attach portion of ExtractIt will not
operate.
LINE 6 of the docread.cfg file
------------------------------
The sixth line tells the door where it should create its ExtractIt.LOG
file. This log file gives a detailed summary of what the user did when
he was inside the door. I highly suggest that you use RAM: but you can
use any device such as df0: or dh0: or even the printer prt:
I don't like sending the file to a disk drive, especially the hard drive
because if there should be a crash or power failure while the door is
writing to the drive, the 'ol read/write error may very well show up.
LINE 7 of the docread.cfg file
------------------------------
The seventh line tells the door whether you wish to allow ZIP compressed
files to be viewed and/or extracted. Due to the very unstable nature
of the Amiga UNZIP utilities, I've added this option. If this door
crashes due to its attempt at dealing with ZIP'd files, simply put a
ZERO in the this position of the docread.cfg file. The number one (1)
in this position will tell the door to utilize any UNZIP utility you
have in your path. (note: I am presently using UNZIP v3.10 by S.H. Smith
with good results. If you need it, FREQ it from my BBS at 1:2606/205-
unzip4.lzh )
IMPORTANT: The first SEVEN lines must have the above information entered
before you begin to list the devices:directories as noted below.
The remainder of the docread.cfg file
-------------------------------------
The remaining lines would have been arrived at, by going into
MEBBSNet config and checking ALL the files areas you have created.
Just create/edit this file with you favorite editor or word processor.
Please also note that these location names can NOT be more than 50
(fifty) characters in length including any semi-colons and slashes.
I have allowed the DocRead.cfg file to have as many as 240 entries.
I seriously doubt that anyone would need more than this (I needed 37
entries.) but if this limitation becomes a real burden, let me know
and I'll adjust it accordingly.
PLEASE NOTE: All DEVICE names must have a colon (:) after the name and
all DIRECTORIES must have a forward slash ( / ) at the end. (See the
above example).
If, once the door is operational, you find that it can not find a file
that you know is on your drive, the first place to look for trouble is
the DocRead.cfg file. The odds are that you did NOT list ALL the
device:directories that you actually use on your system.
- 5 - THINGS YOU SHOULD KNOW
----------------------
A temporary directory is created in your RAM: directory in which numerous
files are created/read and deleted. This entire directory and its contents
are deleted once the user exits the door.
A user log called EXTRACTIT.log will be created when this door is used.
It gives a summary of the users activities while using this utility.
The location of this log file will depend on where you told the door to
create it. (See item -4- above - editing the DocRead.CFG file)
If the file you are interested in is imbedded several directories deep in
the compressed file, just type the FULL path name as its name. This full
path name will be shown to you after you type in the compressed files name.
As an example, lets say that you choose the file, MONSTER.ZOO as the
compressed file. The door will show you the FULL path directory (whether
you are using DocReader or ExtractIt). If one of the paths looks like this:
Monster_Mash/Info/FullDocs/English_Version
and you want the file, English_Version, just type the full path name as I
just showed. You will be rewarded with the file English_Version.
The TESTMESSAGE file is just a ASCII text file that can be modified to
say anything you'd like, BUT IT MUST BE CALLED TESTMESSAGE!! Do not change
its name to anything else or the door will not function.
The .lzh/.arc files created by ExtractIt are uniquely named by use of the
Amiga time clock. I can't image there is anyone who runs MEBBSNet
who doesn't have a time clock installed in his/her machine. As long as
the time/date is set anywhere NEAR accurate :), this naming procedure
should work fine and be totally transparent to you. Keep in mind that these
.lzh/.arc files will be building up in your Email message base, so it is a good
idea to periodically delete them. Since all these .lzh/.arc files will always
have the @ as the first letter in the name, you can simply delete them as
part of your midnight batch file (or your SCAN or BUNDLE files if you
run Fido) with something like this:
delete sh1:messages/1/@#?.lzh
Of course, you should substitute your actual device:directory in place of my
example. I appended the @ to the file name so that the chances of accidently
deleting a wanted or needed file in your Email message base would be very
unlikely. Think about it, how many files do you think you'll ever get in
your Email directory that would begin with the @ (at sign)??? :)
Your users may now choose either LZH or ARC as the final file compression
method when using ExtractIt. This will allow C64 computer owners to extract
files (such as selective text files) and be able to uncompress them on their
machines.
- 6 - WHAT YOU SHOULD HAVE
--------------------
The archive should contain the following files:
1) ExtractIt.doc -------- The file your reading now.
2) ExtractIt -------- The executable door program
3) DocRead.cfg -------- An example (repeat, EXAMPLE!) .cfg file
4) TESTMESSAGE -------- Must go in the Doors:Extract directory!
This door program was compiled with Lattice 5.10b and no errors or
warnings were encountered.
- 7 - THE "It doesn't work" SECTION
-----------------------------
Ok. You have set all this up exactly correct. You try your first viewing
or reading and -- nothing happens. Or worse yet, the BBS crashes or locksup.
Your reaction is the same as mine - "Garbage program", "Who writes this kind
of junk?!", "All the money I spent on this...!!!".
Well, there are a number of possible reasons as to why the door died on
you, the least not being the discovery of a bug. I am most certainly a
novice C programmer and writing doors for MEBBSNet ain't exactly 1st grade!
However, I suggest that you go through the following checklist BEFORE you
come gunning for me. As of this writing, I have operated the door on my BBS
over 1000 times and have had only one failure (I'll explain what that failure
was caused by in a moment).
Failure Checklist
-------------------
Symptom Possible Cause Fix
----------------------------------------------------------------------------
Door locks up as soon Menu modified wrong. Check menu and recompile.
as I enter it. BBS stack setting Raise STACK to at least
to low. 25000.
Door locks up when I All door files are not in Re-read section 2 (SETUP)
try to view or extract their proper places as and follow directions
the contains of a file. noted in section 2 above. carefully.
The file you are attempting Try un-compressing this
to view,read or extract is file directly from the
corrupt in some fashion. CLI. If you are UNABLE
to do it there, the file
is corrupt and should be
discarded. If you ARE able
to view/extract the file
from the CLI you may have
found a bug. Please report
this discovery to me.
Door tells me that a The DocRead.cfg file is Review section 4 above
file is not online incomplete. You have not and add to the .cfg file
when I know for sure entered ALL the dirs where as needed.
that it is. you have files available
for downloads.
A name or names in the Check DocRead.cfg file
DocRead.cfg file is and adjust as needed.
longer than 50 characters.
Door can not find The DocRead.cfg file is Review section 4 above.
ANY file I ask for. missing or in the wrong Put .cfg file in the
location. DOORS:EXTRACT directory.
Door locksup if user BAD PROGRAMMING! Please notify me and
drops carrier while tell me EXACTLY where
inside the door. the user was in the door
when he dropped carrier.
ExtractIt does not The TESTMESSAGE file is Put TESTMESSAGE inside
appear to call on not in the Extract dir. of Doors:Extract dir.
MEBBSNet's Robot
Message utility.
Line numbers 4 and/or 5 Check lines 4 and 5 of
of the .cfg file are the docread.cfg file
incorrect. and make the necessary
corrections.
Everything seems to Line numbers 4 and/or 5 Check lines 4 and 5 of
work but there is no of the .cfg file are the docread.cfg file
message waiting for incorrect. and make the necessary
me in E-mail. corrections.
The docread.cfg message Compare the docread.cfg
area number (line 4) is number and make it match
not the same number you the MEBBSNet Email
have set in the BBS config. config value.
There is a message The Email area as defined REconfigure MEBBSNet so
waiting but no file in MEBBSNet config is NOT the Email area is PRIVATE
when using ExtractIt set up as PRIVATE.
I noticed a weird dir The dir was not deleted by
on my system after a the door because of one or
user exits the door. more of the following:
1) The user did not exit Yell at your user! :)
the door in a normal and then delete the
fashion. directory manually.
2) The dir contains files Set the file bits to
that have their delete delete and then delete
protection bits set, so the weird directory.
they and, therefore the - or -
dir, couldn't be deleted. reboot the Amiga.
When the door tries to You are using ZOO version Replace the present
list a directory of a number 2.00 instead of ZOO you are using
ZOO file, it goes nuts! a higher version with version 2.01
or higher.
I get a crash or guru You may have a ZIP'd Try unzipping the
when the door tries to file that the Amiga UNZIP suspect file from
operate on ZIP'd files. utility can not handle. the CLI. If it also
fails here, this file
should be taken off
line.
Or the UNZIP utility is Put a ZERO on the
flaking out. sixth line of the
docread.cfg file so
that ZIP'd files can
no longer be called.
When users choose ARC ARC utility is not Put the ARC utility
as the final compression in your path or is somewhere in your
method, they get no not named ARC. path and/or name it
file attach or message. as ARC.
The failure I mentioned that I had was indeed due to a corrupt ZIP file.
I was unable to un-zip it from the CLI and it locked up the door due to the
same problem. This may happen with other compressed files as well, but since
we are all diligent Sysops :) we should all be first checking the integrity
of files BEFORE we put them online. (NOTE: The use of ZIP is now a Sysop cfg
option as of version 0.99e of this door).
- 8 - DISCLAIMER
----------
I've taken great efforts to make this door work as it is designed to work.
However, I can not promise that you will not run into problems that I've
yet to discover. I take no responsibility for any crashes or disk trashing
that might occur due to an unforseen bug. I certainly don't expect anything
like that to happen, but.....
The door also checks for dropped carrier at all the the places I feel
could cause a problem. Therefore, MEBBSNet should re-set with no problems
if a user loses carrier while inside the door.
I can personally assure you that this door contains no backdoors or
trojan horses of any kind. It is just a simple MEBBSNet door. It was
also viruii free when it left my computer.
- 9 - HISTORY
-------
DocReader
Version Number Date Changes
---------------- --------- ------------------------------------------
0.90 2/2/91 Internal release - 1st attempt
0.94 2/3/91 Internal release - Added ZOO & LHARC
0.95 2/4/91 Internal release - Added user log
0.96 2/5/91 1st Alpha release - Disabled wildcards
0.97 2/6/91 1st Beta release - Added wrong name check
0.98 2/7/91 2ed Beta release - Dumped ARC for PKAX
0.99 2/8/91 3ed Beta release - Added ZIP
1.00 2/9/91 Release version - Added Viewing dir option
1.01 2/15/91 Release version - Dropped ZIP
2.00 7/7/91 Release version - Added general text viewing
ExtractIt/DocReader
0.80e 8/19/91 1st Beta release - Added ExtractIt section
0.85e 9/12/91 2ed Beta Release - Added toggle option
0.90e 9/25/91 Release version - Added multifile option
0.95e 10/03/91 Release version - Added Email area choice
0.96e 10/05/91 Release version - Dumped BOOZ,added ZOO 2.01
0.97e 10/10/91 Release version - Added log location option
0.98e 10/15/91 Internal release - Added LHA compression
0.99e 10/15/91 Release version - Added ZIP .cfg option
1.00e 11/15/91 Release version - Unique attached file names
1.10e 12/09/91 Release version - ARC choice as final file
1.20e 12/28/91 Internal Release - Added Time/Date stamp to log
StarNet Compatable only
2.00e 02/25/92 Release version - Eliminated RoboWriter
MEBBSNet Compatable only
3.00 09/25/93 Release version - Uses mebbsutility.library
- 10 - THANKS
------
Thanks to Rich Koenig for the ideas (he knows I can't resist stuff like
this!). Thanks to Eric Drewry for the CR/LF stripping routine. Thanks to
Bill Bowling and his fine mebbsutility.library. Thanks to Commodore-Amiga for
the best damn computer ever made. Thanks to SAS/Lattice for the Lattice
compiler and a manual I can actually understand.
- 11 - BUG REPORTS / PRAISE / SHAREWARE
----------------------------------------
Please sent all bug reports, ideas, flames, compliments, or shareware
fees ($10.00 so I can say I actually made some money with this silly hobby),
to:
Al Saveriano
200 Tomahawk Trail
Sparta, New Jersey 07871
Alche-miga BBS
201-398-6360
FREQ's available
FidoNet 1:2606/205.0
CompuServe 72616,2232
- 12 - SOME QUESTIONS FOR YOU
------------------------------
This door has come a long way from the original DocReader concept. Many
of the ideas come directly from MEBBSNet Sysops like yourself.
At this point in time, I don't really have too many new ideas that I can
incorporate into this door. However, you may have a host of suggestions.
Please, let me know what you'd like to see added to this door. I promise
that I'll read all ideas and see what I can implement. Obviously, any new
concepts should be related to the ExtractIt/DocReader theme. I mean, adding
a space invaders game to this door would not be in the interest of most
users! (I don't think!). Please feel free to NetMail me at 1:2606/205 or to
call my BBS at 1-201-398-6360 and drop me a line.
- 13 - REGISTERED OWNERS INFORMATION
------------------------------------
It is now possible to call Alche-miga BBS at 201-398-6360 and pick up the
latest version of your REGISTERED copy of Extractit. As long as you have an
account on Alche-miga (if you don't, please call and get one) and you are
a ShareWare owner of ExtractIt, you will be able to get your updated
registered copy. So....what are you waiting for! :)
All, if you are already an ExtractIt shareware owner, you are also
welcome to call and get your registered version of 3.00 for MEBBSNet.
- 14 - FINAL WORD
------------------
Enjoy your hobby!